API Documentation
MAIN PAGE
NAMESPACES
CLASSES
Documentation
Headers
NilkinsGraphics
Compositor
CompositorManager.h
1
// CompositorManager.h
3
//
5
6
namespace
nkGraphics
7
{
13
class
DLL_GRAPHICS_EXPORT
CompositorManager
final :
public
nkCommon::SingletonClass<CompositorManager>
14
{
15
public :
16
20
CompositorManager
() ;
24
~CompositorManager
() ;
25
26
// Getters
30
Compositor
*
getActiveCompositor
()
const
;
34
Compositor
*
getDefaultCompositor
()
const
;
35
42
Compositor
*
createOrRetrieve
(
const
std::string_view& name) ;
49
Compositor
*
get
(
const
std::string_view& name) ;
58
Compositor
*
getByIndex
(
unsigned
int
index) ;
65
void
rename
(
const
std::string_view& oldName,
const
std::string_view& newName) ;
71
void
erase
(
const
std::string_view& name) ;
72
73
// Setters
80
void
setActiveCompositor
(
Compositor
* compositor) ;
87
void
setDefaultCompositor
(
Compositor
* compositor) ;
88
95
void
prepareForContext
(
RenderContext
* context) ;
96
} ;
97
}
nkGraphics::CompositorManager::getByIndex
Compositor * getByIndex(unsigned int index)
nkGraphics::CompositorManager::prepareForContext
void prepareForContext(RenderContext *context)
nkGraphics::Compositor
A compositor, describing how to compose the rendering pipeline.
Definition:
Compositor.h:21
nkGraphics::CompositorManager::rename
void rename(const std::string_view &oldName, const std::string_view &newName)
nkGraphics::RenderContext
A rendering context, attached to a graphic window to present to the screen.
Definition:
RenderContext.h:12
nkGraphics::CompositorManager::createOrRetrieve
Compositor * createOrRetrieve(const std::string_view &name)
nkGraphics::CompositorManager::getActiveCompositor
Compositor * getActiveCompositor() const
nkGraphics::CompositorManager::get
Compositor * get(const std::string_view &name)
nkGraphics::CompositorManager::~CompositorManager
~CompositorManager()
nkGraphics::CompositorManager::getDefaultCompositor
Compositor * getDefaultCompositor() const
nkGraphics::CompositorManager
Manages the Compositor available in the component.
Definition:
CompositorManager.h:14
nkGraphics::CompositorManager::setActiveCompositor
void setActiveCompositor(Compositor *compositor)
nkGraphics
Encompasses all API of component NilkinsGraphics.
Definition:
BoundingBox.h:7
nkGraphics::CompositorManager::CompositorManager
CompositorManager()
nkGraphics::CompositorManager::erase
void erase(const std::string_view &name)
nkGraphics::CompositorManager::setDefaultCompositor
void setDefaultCompositor(Compositor *compositor)
Generated by
Doxygen
1.8.18